home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbsdoors / sre0990e.zip / UNPACK.EXE / DOCS / SRDOOR.DOC < prev    next >
Text File  |  1993-01-07  |  11KB  |  220 lines
  1.                        ┌────────────────────────────────────┬─────────────┐
  2. ───────────────────────┤                                    │             │
  3.   ─────────────────────┤   SRDOOR Door Conversion Utility   │     4.0     │
  4.     ───────────────────┤                                    │             │
  5.       ─────────────────┼────────────────────────────────────┴─────────────┤
  6.         ───────────────┤                                                  │
  7.           ─────────────┤ * Purpose                                        │
  8.             ───────────┤                                                  │
  9.               ─────────┤ * Command line format                            │
  10.                 ───────┤                                                  │
  11.                   ─────┤ * Setup                                          │
  12.                     ───┤                                                  │
  13.                       ─┤ * Compatibility Information                      │
  14.                        │                                                  │
  15.                        │ * File format                                    │
  16.                        │                                                  │
  17.                        │ * Notes to door game authors                     │
  18.                        │                                                  │
  19. ───────────────────────┴──────────────────────────────────────────────────┴──
  20.   Purpose
  21. ─────────────────────────────────────────────────────────────────────────────
  22.  
  23.          This program reads a BBS door file and converts it into a standard
  24.          Solar Realms format file called DOORFILE.SR.  This one program will
  25.          work with BRE, SRE, SCE, AC6, LEA, PC, SRH, and any other games from
  26.          the Solar Realm.  The purpose of an external door conversion is to
  27.          allow sysops of BBSes not supported by SRDOOR to use another program
  28.          to convert to the DOORFILE.SR file.  For example, if you were
  29.          running a BBS that produced USER.DAT as a door file, and SRDOOR
  30.          did not support it, you could write a program to replace SRDOOR
  31.          that would read USER.DAT and convert it to DOORFILE.SR.  See the
  32.          section, "File Format".
  33.  
  34. ─────────────────────────────────────────────────────────────────────────────
  35.   Format
  36. ─────────────────────────────────────────────────────────────────────────────
  37.  
  38.          SRDOOR [«specialbbstype» [«comport»]]
  39.       or
  40.      SRDOOR -f «filename»
  41.  
  42.          The parameters "specialbbstype" and "comport" are required for
  43.          certain BBS types.  See the "File Format" section for more
  44.          information.
  45.  
  46.      The -f option allows you to choose a setup file other than SETUP.SR.
  47.  
  48.          or
  49.  
  50.      (writing the doorfile directly)
  51.  
  52.      ECHO «username»     >DOORFILE.SR
  53.      ECHO «ansi-status»    >>DOORFILE.SR
  54.      ECHO «ibm-char-status» >>DOORFILE.SR
  55.      ECHO «page-length»    >>DOORFILE.SR
  56.      ECHO «baud-rate»    >>DOORFILE.SR
  57.      ECHO «com-port»    >>DOORFILE.SR
  58.      ECHO «time-limit»    >>DOORFILE.SR
  59.          ECHO «real-name»       >>DOORFILE.SR
  60.  
  61.          For example, if your BBS passes as command line parameters
  62.      the username in %1, the com port in %2, the baud rate in %3,
  63.      and the time limit in %4, but doesn't pass the others, you
  64.      could write into your batch file (instead of SRDOOR):
  65.  
  66.      ECHO %1   >DOORFILE.SR
  67.      ECHO -1  >>DOORFILE.SR
  68.      ECHO -1  >>DOORFILE.SR
  69.      ECHO -1  >>DOORFILE.SR
  70.      ECHO %3  >>DOORFILE.SR
  71.      ECHO %2  >>DOORFILE.SR
  72.      ECHO %4  >>DOORFILE.SR
  73.          ECHO %1  >>DOORFILE.SR
  74.  
  75.      (The -1 means "I don't know this value"; you can use this for
  76.          ANSI, pagelength, IBM character status, and Time Limit.)  Notice
  77.          that the username can be used as the 'real name'; it is better
  78.          if you can find the real name, but if it is not available, you
  79.          can use the handle/username.
  80.  
  81. ─────────────────────────────────────────────────────────────────────────────
  82.   Setup
  83. ─────────────────────────────────────────────────────────────────────────────
  84.  
  85.          Use the INSTALL program to set up a batch file.  It will
  86.          automatically run SRDOOR.
  87.  
  88.          If you have a non-supported BBS, these are some options:
  89.             1.  Use a doorfile converter to convert to a supported format
  90.                 (DOOR.SYS or DORINFO1.DEF preferred)
  91.             2.  Write a program to read your doorfile and write DOORFILE.SR;
  92.                 if you do this, please send us your program so that we may
  93.                 incorporate it into future versions of SRDOOR. (see below)
  94.         3.    Use command-line parameters to write directly to DOORFILE.SR.
  95.         (See above for an example.)
  96.  
  97. ─────────────────────────────────────────────────────────────────────────────
  98.   Compatibility
  99. ─────────────────────────────────────────────────────────────────────────────
  100.  
  101.          We have tested SRDOOR with DOOR.SYS and DORINFO1.DEF; we have not
  102.          been able to test it with the other door types.  If you have any
  103.          useful information, please send it to us!  Also, the tests we
  104.          have done were for DOOR.SYS produced by Telegard, not Wildcat,
  105.          software.
  106.  
  107. ─────────────────────────────────────────────────────────────────────────────
  108.   File Format
  109. ─────────────────────────────────────────────────────────────────────────────
  110.  
  111.          SRDOOR reads text files in which one piece of information is on
  112.          each line.  Unfortunately, some BBS programs do not create these
  113.          types of door files.  For standard door files, view SETUP.SR for
  114.          more information.  For a non-standard door file, SRDOOR currently
  115.          has experimental GTUSER and PCBOARD modes:
  116.  
  117.             SRDOOR PCBOARD1
  118.                Converts PCBoard 14.x type PCBOARD.SYS files to DOORFILE.SR.
  119.             SRDOOR PCBOARD2 «comport»
  120.                Converts PCBoard 12.1 type PCBOARD.SYS files to DOORFILE.SR.
  121.             SRDOOR GTUSER «comport»
  122.                Converts GT type GTUSER.BBS files to DOORFILE.SR.
  123.  
  124.          Notice that the parameter «comport» is needed in the Old PC-Board
  125.          and GT-USER files.  Use the COM port that the modem is attached to
  126.          (1, 2, 3, or 4).
  127.  
  128.          You can also write your own program to convert your favorite door
  129.          file to DOORFILE.SR.  The DOORFILE.SR format is:
  130.  
  131.             (line 1):   Complete name or handle of user
  132.             (line 2):   ANSI status:  1 = yes, 0 = no, -1 = don't know
  133.             (line 3):   IBM Graphic characters:  1 = yes, 0 = no, -1 = unknown
  134.             (line 4):   Page length of screen, in lines.  Assume 25 if unknown
  135.             (line 5):   Baud Rate:  300, 1200, 2400, 9600, 19200, etc.
  136.             (line 6):   Com Port:  1, 2, 3, or 4.
  137.             (line 7):   Time Limit:  (in minutes); -1 if unknown.
  138.             (line 8):   Real name (the same as line 1 if not known)
  139.  
  140.          There is a program called GENPC that does this for Genesis Deluxe
  141.          BBS software; P2SR does this for PC-Board 14.x; Maximus and
  142.          Searchlight software can create this file directly.
  143.  
  144. ─────────────────────────────────────────────────────────────────────────────
  145.   What's new
  146. ─────────────────────────────────────────────────────────────────────────────
  147.  
  148.          ■ The main change from 3.1 was the addition of line 8,
  149.            the "Real Name" line.  This line will be used in the
  150.            future for BRE's "dupe-checking" feature.
  151.  
  152.          ■ Colors were added to make the display nicer.
  153.  
  154.          ■ The executable size shrank 30% when I converted from C++
  155.            to Turbo Pascal.
  156.  
  157. ─────────────────────────────────────────────────────────────────────────────
  158.   Bugs
  159. ─────────────────────────────────────────────────────────────────────────────
  160.  
  161.  
  162.          <> Not tested for BBS types other than DOOR.SYS and DORINFO1.DEF.
  163.  
  164.          <> PCBOARD 14.x doesn't work, but there is a program called
  165.             P2SR on our board that replaces SRDOOR and handles PCBOARD.SYS
  166.  
  167. ─────────────────────────────────────────────────────────────────────────────
  168.   Notes to Online Game Writers
  169. ─────────────────────────────────────────────────────────────────────────────
  170.  
  171.          We at the Solar Realm encourage you to use this door file format.
  172.          We feel it has all the necessary information for a door game.  It
  173.          also has the advantage of being easy to read in a variety of
  174.          languages (unlike many door files being used that require BASIC,
  175.          Pascal, or C).  By using an external door conversion program, you
  176.          leave open the option for sysops to write their own converter so that
  177.          those sysops who have BBSes that your game does not support may be
  178.          able to find or write a replacement for SRDOOR.  Both Battle
  179.          Quest (BQ) and The Unknown Quest (TUQ) use the DOORFILE.SR format
  180.          and SRDOOR.
  181.  
  182. ─────────────────────────────────────────────────────────────────────────────
  183.   Source Code Availability
  184. ─────────────────────────────────────────────────────────────────────────────
  185.  
  186.          I have both C++ and Pascal versions of SRDOOR.  SRDOOR 4.0 as
  187.          distributed with SRE is the Pascal version.  Source code is
  188.          available upon request.
  189.  
  190. ─────────────────────────────────────────────────────────────────────────────
  191.   Contact
  192. ─────────────────────────────────────────────────────────────────────────────
  193.  
  194.          For more information, contact the Solar Realm BBS at (713)855-1665.
  195.          (19.2k USR/DS.; 1:106/900 fido)
  196.  
  197. ─────────────────────────────────────────────────────────────────────────────
  198.   Disclaimer
  199. ─────────────────────────────────────────────────────────────────────────────
  200.  
  201.          This program is not guaranteed to work.  It is distributed "as-is".
  202.          If you find it useful, great!  If not, we are in no way to be held
  203.          responsible.  No contribution is required to use this program.  It
  204.          is meant to be used with Solar Realms door programs.
  205.  
  206. ─────────────────────────────────────────────────────────────────────────────
  207.   Usage
  208. ─────────────────────────────────────────────────────────────────────────────
  209.  
  210.          If any person wishes to use this program for any other legal use,
  211.          the only requirement is that she or he write a letter to the Solar
  212.          Realm BBS informing them that SRDOOR is being used.  Please describe
  213.          your project.  We are interested in keeping track of all persons
  214.          using SRDOOR (for upgrade notices and information purposes).  No
  215.          charge is required to use SRDOOR, and no fee may be charged for its
  216.          distribution.  This documentation file must accompany SRDOOR.
  217.  
  218. ─────────────────────────────────────────────────────────────────────────────
  219.  
  220.